<!doctype html>
<html lang="en">
<head>
    <title>API for class paramTag (phpAPI: PHP Documentation Creator version 6.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link rel="stylesheet" type="text/css" href="../style.css">
    <link rel="start" href="../index.html">
</head>
    <body id="paramTag" onload="parent.document.title=document.title;">
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../tags/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../tags/package-tree.html">tags\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    <hr />
<div class="package">Namespace tags</div>
<h1>Class paramTag</h1>
<div id="list">
    <ul>
        <li><a href="../tags/tag.html">tag</a><ul><li><strong>paramTag</strong></li></ul></li>    </ul>
</div>
<hr />
<p class="arguments">public  class <strong>paramTag</strong> extends <a href="../tags/tag.html">tag</a></p>
<div class="comment" id="overview_description">Represents a parameter tag.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">phpapi: PHP Documentation Creator</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">6.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov greenray.spb@gmail.com</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2015-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">/system/taglets/paramTag.php</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Overview</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Represents a documentation tag.
 Tag is a keyword (e.g. @version) with value (e.g. 1.0)</td>
                    </tr>
        </table>
</div>
            <table class="inherit">
            <tr><th>Fields inherited from tags \ tag</th></tr>
            <tr>
                <td>
                                    <span><a href="../tags/tag.html#$name"><span class="green">$name, </span></a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#$parent"><span class="green">$parent, </span></a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#$root"><span class="green">$root, </span></a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#$text"><span class="green">$text, </span></a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#$type"><span class="green">$type</span></a>&nbsp;</span>
                                </td>
            </tr>
        </table>
                <table class="inherit">
            <tr><th>Methods inherited from tags \ tag</th></tr>
            <tr>
                <td>
                                    <span><a href="../tags/tag.html#displayName">displayName, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#firstCommentString">firstCommentString, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#getInlineTags">getInlineTags, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#inField">inField, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#inMethod">inMethod, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#inOverview">inOverview, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#inPackage">inPackage, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#inType">inType, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#inlineTags">inlineTags, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#setParent">setParent, </a>&nbsp;</span>
                                    <span><a href="../tags/tag.html#tag">tag</a>&nbsp;</span>
                                </td>
            </tr>
        </table>
        <h2 id="details_fields">Fields</h2>
            <div class="location">system/taglets/paramTag.php at line 17</div>
        <pre class="arguments" id="var">public  string <strong><span class="green">$var</span></strong> = NULL;</pre>
        <div class="details">Variable name of the parameter</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">system/taglets/paramTag.php at line 26</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>(<span class="lilac">string</span> <span class="blue">$text</span>, <span class="lilac">array</span> <span class="blue">&$data</span>, <a href="../phpapi/rootdoc.html">rootDoc</a> <span class="blue">&$root</span>)</code>
    <div class="details">
            <p class="description">Constructor.</p>
        <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$text</td>
                <td class="hid">Contents of the tag</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">&$data</td>
                <td class="hid">Reference to the doc comment data array</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac"><a href="../phpapi/rootdoc.html">rootDoc</a></td>
                            <td class="hid blue w_100">&$root</td>
                <td class="hid">Reference to the root object</td>
                    </tr>
        </table>
</div>
    </div>
    <h2 id="details_methods">Methods</h2>
            <div class="location">system/taglets/paramTag.php at line 49</div>
        <code class="arguments" id="displayName">public  string <strong>displayName</strong> ()</code>
        <div class="details">
                    <p class="description">Displays the name of this tag.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2"><span class="red">"Parameters"</span></td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/taglets/paramTag.php at line 58</div>
        <code class="arguments" id="inField">public  boolean <strong>inField</strong> ()</code>
        <div class="details">
                    <p class="description">Returns FALSE if this Taglet is not used in field documentation.</p>
                    </div>
        <hr />
            <div class="location">system/taglets/paramTag.php at line 67</div>
        <code class="arguments" id="inMethod">public  boolean <strong>inMethod</strong> ()</code>
        <div class="details">
                    <p class="description">Returns TRUE if this Taglet is used in method documentation.</p>
                    </div>
        <hr />
            <div class="location">system/taglets/paramTag.php at line 76</div>
        <code class="arguments" id="inOverview">public  boolean <strong>inOverview</strong> ()</code>
        <div class="details">
                    <p class="description">Returns FALSE if this Taglet is not used in overview documentation.</p>
                    </div>
        <hr />
            <div class="location">system/taglets/paramTag.php at line 85</div>
        <code class="arguments" id="inPackage">public  boolean <strong>inPackage</strong> ()</code>
        <div class="details">
                    <p class="description">Returns FALSE if this Taglet is not used in package documentation.</p>
                    </div>
        <hr />
            <div class="location">system/taglets/paramTag.php at line 94</div>
        <code class="arguments" id="inType">public  boolean <strong>inType</strong> ()</code>
        <div class="details">
                    <p class="description">Returns FALSE if this Taglet is not used in class or interface documentation.</p>
                    </div>
        <hr />
        <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../tags/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../tags/package-tree.html">tags\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    </body>
</html>
